API Documentation
Public Member Functions | List of all members
nkWinUi::GridLayout Class Referencefinal

Implements a layout organizing children components in a grid. More...

Inheritance diagram for nkWinUi::GridLayout:
nkWinUi::Layout nkExport::Exportable

Public Member Functions

 GridLayout ()
 
 ~GridLayout ()
 
ComponentgetComponentAt (unsigned int index)
 
virtual void setParentComponent (Component *parent) override
 
void setGridWidth (unsigned int value)
 
void setGridHeight (unsigned int value)
 
void setFixedSizeRow (unsigned int rowIndex, unsigned int sizePix)
 
void setFixedSizeCol (unsigned int colIndex, unsigned int sizePix)
 
void setInternalBorderWidth (unsigned int valuePix)
 
void setInternalBorderHeight (unsigned int valuePix)
 
void addComponent (Component *component, int x, int y, int width, int height)
 
virtual void removeComponent (Component *component) override
 
virtual void update () override
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void exportComponentsNodeEntry (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
virtual void processComponentsNodeEntry (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Layout
 Layout ()
 
virtual ~Layout ()
 
ComponentgetParentComponent () const
 
LAYOUT_TYPE getType () const
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

Implements a layout organizing children components in a grid.

This layout will alter the components size to make them fit within the bounds of the window, as described by its settings.

Constructor & Destructor Documentation

◆ GridLayout()

nkWinUi::GridLayout::GridLayout ( )

Constructor.

◆ ~GridLayout()

nkWinUi::GridLayout::~GridLayout ( )

Destructor.

Member Function Documentation

◆ getComponentAt()

Component* nkWinUi::GridLayout::getComponentAt ( unsigned int  index)
Parameters
indexThe wanted component's index.
Returns
The child component at given index, if available. If out of bounds, nullptr.

◆ setParentComponent()

virtual void nkWinUi::GridLayout::setParentComponent ( Component parent)
overridevirtual

◆ setGridWidth()

void nkWinUi::GridLayout::setGridWidth ( unsigned int  value)

Sets the width of the grid to organize children components. This corresponds to the number of cells to use.

Parameters
valueThe width to use.

◆ setGridHeight()

void nkWinUi::GridLayout::setGridHeight ( unsigned int  value)

Sets the height of the grid to organize children components. This corresponds to the number of cells to use.

Parameters
valueThe height to use.

◆ setFixedSizeRow()

void nkWinUi::GridLayout::setFixedSizeRow ( unsigned int  rowIndex,
unsigned int  sizePix 
)

Allows to add a row that will have a fixed size in pixels.

Parameters
rowIndexThe index of the row having a fixed size.
sizePixThe size it will have, in pixels.

◆ setFixedSizeCol()

void nkWinUi::GridLayout::setFixedSizeCol ( unsigned int  colIndex,
unsigned int  sizePix 
)

Allows to add a column that will have a fixed size in pixels.

Parameters
colIndexThe index of the row having a fixed size.
sizePixThe size it will have, in pixels.

◆ setInternalBorderWidth()

void nkWinUi::GridLayout::setInternalBorderWidth ( unsigned int  valuePix)

Sets the border width in between children components.

Parameters
valuePixThe width, in pixels.

◆ setInternalBorderHeight()

void nkWinUi::GridLayout::setInternalBorderHeight ( unsigned int  valuePix)

Sets the border height in between children components.

Parameters
valuePixThe height, in pixels.

◆ addComponent()

void nkWinUi::GridLayout::addComponent ( Component component,
int  x,
int  y,
int  width,
int  height 
)

Add a component to this layout, describing its position in the grid.

Parameters
componentThe component to add.
xThe x origin in the layout's grid. Starts indexing at 0.
yThe y origin in the layout's grid. Starts indexing at 0.
widthThe width, in cells number, in the grid.
heightThe height, in cells number, in the grid.

◆ removeComponent()

virtual void nkWinUi::GridLayout::removeComponent ( Component component)
overridevirtual

◆ update()

virtual void nkWinUi::GridLayout::update ( )
overridevirtual

◆ exportClassToTree()

virtual void nkWinUi::GridLayout::exportClassToTree ( nkExport::Node rootNode)
overridevirtual

See Layout::exportClassToTree().

Reimplemented from nkWinUi::Layout.

◆ exportComponentsNodeEntry()

virtual void nkWinUi::GridLayout::exportComponentsNodeEntry ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkWinUi::GridLayout::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

◆ processComponentsNodeEntry()

virtual void nkWinUi::GridLayout::processComponentsNodeEntry ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: